@aws-sdk/signature-v4

What is @aws-sdk/signature-v4?

@aws-sdk/signature-v4 is a package from the AWS SDK for JavaScript that provides functionality to sign AWS requests using the Signature Version 4 signing process. This is essential for securely making authenticated requests to AWS services.

What are @aws-sdk/signature-v4's main functionalities?

Signing HTTP Requests

This feature allows you to sign HTTP requests to AWS services using the Signature Version 4 signing process. The code sample demonstrates how to sign a GET request to an S3 bucket.

const { SignatureV4 } = require('@aws-sdk/signature-v4');
const { Sha256 } = require('@aws-crypto/sha256-js');
const { HttpRequest } = require('@aws-sdk/protocol-http');

const signer = new SignatureV4({
  service: 's3',
  region: 'us-east-1',
  credentials: {
    accessKeyId: 'AKID',
    secretAccessKey: 'SECRET'
  },
  sha256: Sha256
});

const request = new HttpRequest({
  method: 'GET',
  hostname: 'examplebucket.s3.amazonaws.com',
  path: '/exampleobject'
});

signer.sign(request).then(signedRequest => {
  console.log(signedRequest);
});

Presigning URLs

This feature allows you to generate presigned URLs for AWS services, which can be used to grant temporary access to resources. The code sample demonstrates how to presign a URL for an S3 object.

const { S3RequestPresigner } = require('@aws-sdk/s3-request-presigner');
const { HttpRequest } = require('@aws-sdk/protocol-http');
const { Hash } = require('@aws-sdk/hash-node');
const { formatUrl } = require('@aws-sdk/util-format-url');

const presigner = new S3RequestPresigner({
  credentials: {
    accessKeyId: 'AKID',
    secretAccessKey: 'SECRET'
  },
  region: 'us-east-1',
  sha256: Hash.bind(null, 'sha256')
});

const request = new HttpRequest({
  method: 'GET',
  hostname: 'examplebucket.s3.amazonaws.com',
  path: '/exampleobject'
});

presigner.presign(request).then(presignedUrl => {
  console.log(formatUrl(presignedUrl));
});

Other packages similar to @aws-sdk/signature-v4

aws4

The aws4 package is a lightweight library for signing AWS requests with Signature Version 4. It is simpler and has fewer dependencies compared to @aws-sdk/signature-v4, making it a good choice for smaller projects or environments with limited resources.

aws-signature-v4

The aws-signature-v4 package is another library for signing AWS requests using Signature Version 4. It is designed to be compatible with both Node.js and browser environments, similar to @aws-sdk/signature-v4, but it may not be as feature-rich or tightly integrated with the AWS SDK.

README

@aws-sdk/signature-v4

Changelog

1.0.0-rc.10 (2020-12-15)

Bug Fixes

• remove some s3 waiters (#1791) (6f73e9b)

Features

• clients: waiter code generation (#1784) (c78d705)
• util-waiter: add createWaiter() (#1759) (3d6eb2d)
• update clients as of 12/12/2020 (#1771) (f69ff44)
• update clients as of 12/12/2020 with model fixes (#1774) (54e8715)